<?php
/**
 * @category   Swishe
 * @package    Swishe_Results_Interface
 * @copyright  Copyright (c) 2009 David L Norris (http://code.google.com/p/sws)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
interface Swishe_Results_Interface
{
	/* Number of Results */
	public static $hits = 0;

    /**
     * get list of parsed words
     *
     * @returns array $words
     * @throws Swishe_Results_Exception
     */
    public static function parsedWords();

    /**
     * get list of stop words
     *
     * @returns array $stopWords
     * @throws Swishe_Results_Exception
     */
    public static function removedStopwords();

    /**
     * seek to result offset
     *
     * @returns boolean $success
     * @throws Swishe_Results_Exception
     */
    public static function seekResult( $position );

    /**
     * return the next result
     *
     * @return Swishe_Result $result
     * @throws Swishe_Results_Exception
     */
    public static function nextResult();

}